IJob::HistoryRetentionOptions Property

Gets or sets the option that determines the rule adTempus uses to purge history records for the job.

C++

__property HistoryRetentionOptionsEnum HistoryRetentionOptions;

HistoryRetentionOptionsEnum HistoryRetentionOptions;

Visual Basic

Property HistoryRetentionOptions() As HistoryRetentionOptionsEnum

Default Value

hrUseDefault

Description

Set to any of the HistoryRetentionOptionsEnum values.

If the option is set to hrUseDefault, the job uses the default settings for the server. To modify those defaults, use the Scheduler's GetServerOptions method to get the ServerOptions, then modify the values for options "HistoryScavenger:DefaultRetentionType" (default for HistoryRetentionOptions) and "HistoryScavenger:DefaultRetentionInterval" (default for HistoryRetentionLimit) (see the example in the IServerOptions overview).